home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr18 / btrip13.zip / BATTLE.DOC next >
Text File  |  1995-02-05  |  20KB  |  484 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.      _____________________________________________________________________
  19.  
  20.  
  21.  
  22.  
  23.                                Battle Trip v1.3
  24.  
  25.                                   Written by
  26.  
  27.                                  Rob Williams
  28.                                  WCS Software
  29.  
  30.  
  31.      _____________________________________________________________________
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.                           
  52.                             Copyright Notice
  53.                             ----------------
  54.  
  55.      This door game is distributed under the SHAREWARE concept.  This
  56.      concept gives you the chance to "try before you buy", and see if it
  57.      meets your needs.  
  58.  
  59.      I've decided to break away from the standard "30 day trial period"
  60.      that many door authors are using and instead go to a much simpler 
  61.      and more realistic policy. This is simply; Try it on your BBS.
  62.      If you like it and your users like it, then register it.  If it's not 
  63.      good enough to register, then delete it.  
  64.  
  65.      While I'd like you to register my doors as soon as possible, I'm also 
  66.      realistic enough to know that different boards have different requirements
  67.      and interests, and sometimes it takes longer befor a game catches on, or a
  68.      sysop can get to the Doors on his list to register.  And frankly, I'd 
  69.      rather you ran it for awhile and register, than try it for a short 
  70.      period of time and delete it. Nobody wins that way...I lose out on a 
  71.      registration and your users lose out on the chance of having the 
  72.      registered door to play.
  73.  
  74.      The above "extended trial" statement was copied with permission from
  75.      Mike Jordan of M&S Doors.
  76.  
  77.      As a shareware  program, Battle Trip may be freely distributed.
  78.      Shareware distributors may distribute copies of Battle Trip on disk 
  79.      for a modest disk duplication charge not to exceed $4 per disk.
  80.  
  81.  
  82.  
  83.                                     Warranty
  84.                                     --------
  85.  
  86.      Battle Trip is distributed on as as is basis.  In no event will
  87.      Rob Williams or WCS Software be liable to you for damages, including 
  88.      any loss of profits, lost savings, or other incidental or  
  89.      consequential damages arising out of your use of or inability to use 
  90.      this program, even if Rob Williams, WCS Software, or an authorized 
  91.      representative has been advised of the possibility of such damages.  
  92.      Rob Williams and WCS Software will not be liable for any such claim 
  93.      by any other party.
  94.  
  95.  
  96.                             Features of Battle Trip
  97.                             -----------------------
  98.  
  99.      Assembly language serial input/output routines for maximum speed.
  100.  
  101.      Fully supports high speed modems: 16550 FIFO buffering and locked
  102.      serial ports.
  103.  
  104.      Built in ANSI terminal emulator.  No need to have ANSI.SYS loaded in
  105.      memory.
  106.  
  107.      DesqView, Windows, and OS/2 aware.
  108.  
  109.      Supports all of the most popular door data file formats:
  110.      TriBBS, PCBoard, GAP  (DOOR.SYS), Spitfire, WildCat!,  RBBS, and WWIV.
  111.  
  112.      ANSI and ASCII Bulletins of high scorers.
  113.  
  114.      Automatic monthly maintenance with no intervention from the Sysop.
  115.  
  116.      Supports play ahead and make up days when registered.  This is
  117.      completely sysop configurable.
  118.  
  119.      Battle Trip is Multinode Aware!
  120.  
  121.  
  122.                          Files used in the Program
  123.                          -------------------------
  124.  
  125.      BATTLE.EXE    -   The main battle trip program
  126.  
  127.      REGISTER.FRM  -   Information on registration
  128.  
  129.      SAMPLE.CFG    -   Sample configuration file
  130.  
  131.      SAMPLE.BAT    -   Sample batch file to run battle trip
  132.  
  133.      HISCORE.DAT   -   Created when the program runs-contains hi score info
  134.  
  135.      USER.DAT      -   Created when the program runs-contains user info
  136.  
  137.      BATTLE.KEY    -   Key file for registered versions
  138.  
  139.      BATTLE.USE    -   Created when the game is running, will be deleted
  140.                        when the user exits normally.  
  141.                        (only in single user/non-registered versions)
  142.      
  143.      ************************************************************************
  144.      ** IMPORTANT - The game will not run if this file (BATTLE.USE) exists **
  145.      ************************************************************************
  146.  
  147.      BATTLE.HLP    -   Help file for the game.  When the Instructions option
  148.                        is selected, this file is displayed.  You may edit
  149.                        this file if you wish.  It is a plain ASCII text file.
  150.  
  151.      BATTLE.HIS    -   History of the product.  Shows what enhancements were
  152.                        made in what version.
  153.  
  154.      WCSINFO.TXT   -   A text file explaining more about WCS Software and 
  155.                        showing all currently available WCS Software programs.
  156.  
  157.      READ.ME       -   A brief text file explaining how to get up and running
  158.                        quickly.
  159.  
  160.  
  161.                            Setting up Battle Trip
  162.                            ----------------------
  163.  
  164.      Battle Trip is run by  entering a command similar to the
  165.      following:
  166.       
  167.      BATTLE BATTLE.CFG
  168.  
  169.      The configuration file can have any name you choose, but it must
  170.      reside in the same directory as the door.  The configuration file is
  171.      an ASCII text file with the following format:
  172.  
  173.      Line 1:   Door data file type.
  174.      Line 2:   Path to the door data file(s).
  175.      Line 3:   BBS name.
  176.      Line 4:   Sysop's name.
  177.      Line 5:   Locked baud rate.
  178.      Line 6:   ASCII High Score Bulletin Name
  179.      Line 7:   ANSI High Score Bulletin Name
  180.      Line 8:   Number of Games per day 
  181. *    Line 9:   Number of extra days allowed for make up days
  182. *    Line 10:  Day to start playing make up days-31 to disable
  183.      Line 11:  Write log files (explained below)
  184. *    Line 12:  Line to display a message (donated by, etc)
  185.      Line 13:  Name you want the computer opponent to have
  186.  
  187.      Lines with a "*" to the left indicate features only present in the
  188.      registered version of the program.  *** The lines must be present,
  189.      even if the door is not registered. ***
  190.  
  191.      As illustrated above, the door's data file type is specified in line 1
  192.      and can be PCB for PCBoard, GAP for GAP (DOOR.SYS), SF for Spitfire,
  193.      RBBS for RBBS, WC for WildCat!, TRIBBS for TriBBS, or WWIV for WWIV. 
  194.      The locked baud rate is specified in line 5.  If you don't lock your
  195.      serial port, you must specify 0 for the locked baud rate.  
  196.      The following is a sample door configuration file:
  197.  
  198.      ************************************************************************
  199.      ** IMPORTANT - If you are running WC 4.x, use the GAP drop file       **
  200.      ************************************************************************
  201.  
  202.      WC                             <== BBS Type
  203.      C:\WC30\WCWORK\NODE1           <== Drop file location
  204.      WCS Software BBS               <== BBS Name
  205.      Rob Williams                   <== Sysop Name
  206.      0                              <== Locked baud rate
  207.      C:\WC30\BULL\BULL10.BBS        <== ASCII bulletin
  208.      C:\WC30\BULL\BULL10.SCR        <== ANSI bulletin
  209.      10                             <== # of questions per day
  210.      2                              <== Extra days allowed for make up days
  211.      10                             <== Day to start make up days
  212.      A                              <== Write a log file (See Below)
  213.      By WCS Software                <== Donated by line
  214.      Computers Name                 <== Name as you want it to appear for
  215.                                         computer opponent
  216.      ************************************************************************
  217.      ** IMPORTANT - Even if the game is not registered, the last  three    **
  218.      ** lines must exist, or the game will not run.  You will get an error **
  219.      ** when the game starts up.                                           **
  220.      ************************************************************************      
  221.  
  222.      On line 11, the valid options for a log file are:
  223.         - P for Play log ONLY  (WCSUNO.nodenumber)
  224.         - N for No logs
  225.         - C for Comments log ONLY (COMMENTS.MSG)
  226.         - A for ALL Logs (play log and comment log)
  227.  
  228.      Battle Trip can be run locally without a door data file (handy
  229.      for the sysop to use the door without logging on to the BBS) by
  230.      specifying /L after the  configuration  file  parameter in  the  DOS 
  231.      command line.  BT will request you to enter your name before running
  232.      the door.
  233.  
  234.      To play the game in Multiuser mode, you must have a registered multinode 
  235.      copy,and DOS SHARE must be loaded.  If these two things are not done,  
  236.      the game will display a message if you try to run multinode.
  237.  
  238.      Nonstandard IRQs can be used by specifying the IRQ number after the 
  239.      "config" parameter in the command line used to run the door as
  240.      follows:
  241.  
  242.      BATTLE BATTLE.CFG 4
  243.  
  244.               Setting up Battle Trip for Multinode Play
  245.               -----------------------------------------
  246.  
  247.     In order to set Battle Trip up for multinode play, you need to create a
  248.     .cfg file for each node that will be using the game.  The .cfg files
  249.     will be similar, except that lines 2 and possibly 5 will be different.
  250.     Line 2 is the location of the door drop file.  This needs to be unique
  251.     for each node that runs the game.  Line 5 is the locked baud rate for
  252.     the node.  If you have nodes that are locked at different rates, then
  253.     this line may be different for different nodes.  For example, the
  254.     configuration file for node 1 (BATTLE.CF1) might look like this:
  255.  
  256.       GAP
  257.       H:\WILDCAT\WCWORK\NODE1     <=== Notice this is the node 1 directory
  258.       Williams Computer Services BBS
  259.       Rob Williams
  260.       19200
  261.       [etc].....
  262.  
  263.     And the configuration file for node 2 (BATTLE.CF2) might look like this:
  264.  
  265.       GAP
  266.       H:\WILDCAT\WCWORK\NODE2     <=== Notice this is the node 2 directory
  267.       Williams Computer Services BBS
  268.       Rob Williams
  269.       19200
  270.       [etc].....
  271.  
  272.     You will also need to set an environment variable to tell the program
  273.     what node it is currently running on.  Since I run Wildcat, I call
  274.     this variable WCNODEID.  In my .BAT file that calls the BBS, I set the
  275.     WCNODEID to whatever node is running.  You can use wahtever name you
  276.     wish, it just needs to be a unique node ID.
  277.  
  278.     Next, in the batch file that calls BT, you would change the sample.bat
  279.     that is included with this archive to look like this:
  280.  
  281.        CD\BATTLE
  282.        BATTLE BATTLE.CF%WCNODEID%
  283.  
  284.     What this will do, is when the game is started, it will look for the
  285.     WCNODEID (or whatever you called it), and append that to BATTLE.CF.  So
  286.     when the game runs, and you run it from node 1 say, it will use .cfg file
  287.     BATTLE.CF1.
  288.  
  289.     Hopefully, I have not totally confused you on how to set the door up for
  290.     mult-node use.  If you have questions on environment variables, refer
  291.     to your DOS manual.
  292.  
  293.    **************************************************************************
  294.    ** Running this game on more than a single node requires a Multi-Node   **
  295.    ** Key.  When running in Evaluation mode, only one (1) Node will be able**
  296.    ** to access the door at a time.                                        **
  297.    **************************************************************************
  298.  
  299.  
  300.                             Playing the Game
  301.                             ----------------
  302.  
  303.      Battle Trip is based on the card game Mille Borne.  When you enter the
  304.      door, you come to a menu of four options.  They are:
  305.  
  306.        P)lay Battle Trip - Starts the game
  307.        H)igh scores - Shows the high score bulletin
  308.        I)nstructions - Displays this file
  309.        Q)uit - Exits the game
  310.  
  311.  
  312.      Available Keys
  313.      --------------
  314.      After choosing the "P" option from the main menu, you are brought to the
  315.      main play screen.  From this screen there are four options:
  316.  
  317.        P)lay card - To play a card from your hand
  318.        D)iscard - To discard a card from your hand
  319.        C)oup Fourre - To play a safety on a hazard on your battle pile
  320.        R)edraw Screen - Redraws the screen if you get line noise, etc.
  321.        H)igh scores - Shows the high score bulletin
  322.        I)nstructions - Displays this file
  323.        Q)uit - Exits the game
  324.  
  325.      Parts of the Game
  326.      -----------------
  327.      There are four different types of cards in the game.
  328.      Hazards - Out of gas, Flat Tire, Accident, Speed Limit, Stop
  329.      Remedies - Gasoline, Spare Tire, Repairs, End of Limit, Roll
  330.      Safeties - Extra Tank, Puncture Proof, Driving Ace, Right of Way
  331.      Distance - 200, 100 75, 50, 25 miles
  332.  
  333.      The board is laid out as follows:
  334.      Battle Pile : This is where you play hazards (except for speed limits)
  335.                    on the computers pile, and remedies on your pile.  To
  336.                    play a distance card, you must have a roll card on top
  337.                    of your battle pile.
  338.      Speed Pile  : This is where you play speed limits (on the computers
  339.                    pile), and end of limits (on your pile)
  340.      Safety      : This is where you play any safety cards you have.  Once
  341.                    you play a safety card, the computer cannot play the
  342.                    associated hazard card.
  343.      Distance Pile-You cannot see these stacks, but you do see the total
  344.                    distance you have travelled under Total Miles.
  345.  
  346.      The object of the game is to "travel" 1000 miles before the computer does.
  347.      To play miles, you must have a Roll card on the top of your battle pile.
  348.      If you have a speed limit on your speed pile, you cannot travel any
  349.      further than 50 miles in a trip.
  350.  
  351.      During each turn, you will draw a card from the pile, and then either
  352.      P)lay, D)iscard, or C)oup Fourre a card.  To start, you need to play a
  353.      Roll card, then you can play distance cards as long as you have a roll
  354.      card on top of your battle pile.
  355.  
  356.      If you have played all your games for the day, you will be asked if you
  357.      want to view the high scores.  Then you will be returned to the BBS.
  358.  
  359.  
  360.      Scoring
  361.      -------
  362.      For each game, you are scored as follows:
  363.  
  364.      Miles Played    : As shown
  365.      Safeties Played : 100 for each safety played
  366.      Coup Fourees    : 300 for each safety that was coup foureed
  367.      Trip Completed  : 400 points for completing the trip
  368.      Safe Trip       : 300 points if no 200 mile cards were played
  369.      All safeties    : 300 points if you play all 4 safeties
  370.      Shut Out        : 500 points if you complete trip and computer has 0 miles
  371.  
  372.      When you go into the door, you will see an opening screen, it will
  373.      wait for you to press a key, then show you the main menu.  From here,
  374.      there are four options.  P will take you to the playing screen, H will
  375.      show you the high score list, I will show you a help file for playing
  376.      the game, and Q will return you to the BBS.
  377.  
  378.      The first time a player plays the game each month, the system will
  379.      automatically reset the player statistics.  This process should not
  380.      take more than a few seconds, and is automatic, so no intervention
  381.      from the Sysop is necessary.
  382.  
  383.                            Make-Up Days Explanation
  384.                            ------------------------
  385.  
  386.      The make up days feature warrants a little more explanation here.
  387.      When the game is registered, after you have played your game for today,
  388.      it will check to see if make up days has been enabled (start day < 31).
  389.      If today is greater than the start day, and the total number of days you
  390.      have played is not greater than what was specified in the .cfg file, it
  391.      will ask you if you want to play a make up day.  It will then show a
  392.      calendar of days for the current month.  Days that you have played will
  393.      show up in red with an x, playable days will show up in green with an o.
  394.      Choose a valid date (one with an o, within the current month), and you
  395.      will start another days game.  If you changed your mind and do not want
  396.      to play a make up day, enter 99, and you will be asked if you want to
  397.      view the high scores, then be returned to the BBS.
  398.                             
  399.                               Special Keys
  400.                               ------------
  401.                                     
  402.      While BT is running, the sysop can press certain special keys to
  403.      perform a variety of functions.   The following is a list of the
  404.      functions that the special keys perform:
  405.  
  406.      Key(s)              Function
  407.  
  408.      HOME                Toggles between the user  status window and a help
  409.                          display that lists the special keys.
  410.  
  411.      F6                  Takes 5 minutes away from the caller.
  412.                          NOTE:  This will NOT be returned to BBS.
  413.  
  414.      F7                  Gives 5 minutes to the caller.
  415.                          NOTE:  This will NOT be returned to the BBS.
  416.  
  417.      F9                  Quit the door and return the caller to the BBS.
  418.  
  419.      F10                 Enter  chat mode.  Pressing the  ESC key exits the
  420.                          chat mode.
  421.  
  422.      Alt+D               Drop to DOS.
  423.  
  424.                                  
  425.                                 Support
  426.                                 -------
  427.  
  428.      If you have problems, I will try and help as best I can, whether you
  429.      are registered or not.  Registered users will get priority over non-
  430.      registered users, though.  You may get help with problems by calling 
  431.      Williams Computer Services BBS at (503) 631-8439, or by writing to 
  432.      the author at the following addresses:
  433.  
  434.      FIDO      : 1:105/278
  435.  
  436.      Internet  : rob@wcs.org
  437.  
  438.      US Mail:
  439.  
  440.           Rob Williams
  441.           18370 S. Henrici Road
  442.           Oregon City, OR 97045
  443.  
  444.  
  445.                          Registering Battle Trip
  446.                       -----------------------------
  447.  
  448.      Registration of Battle Trip is only $15.00 for single node
  449.      or $20.00 for Multi-Node.   Please use the form in the file
  450.      REGISTER.FRM.   When  you register,  you will receive a registration
  451.      key that will turn your version into a registered version.
  452.  
  453.      Registered users will have access to the special area of the support
  454.      BBS for additional questions, and also be able to add new questions,
  455.      edit questions and users, print questions and users, and import and
  456.      export questions.
  457.  
  458.  
  459.         ***** ALL UPDATES ARE FREE FOR THE LIFE OF THE PROGRAM *****
  460.  
  461.                             Acknowledgements
  462.                             ----------------
  463.  
  464.  Thanks go to the following people/companies (Listed in no particular order):
  465.  
  466.           - Mustang Software for creating Wildcat!
  467.           - Randy Hunt and Mark Goodwin for creating RMDoor which was used
  468.             to create this game.
  469.           - Mike Jordan for his help with some of the routines, and for the
  470.             idea of the make up days, and also help in testing, and his help 
  471.             in helping me get started in door programming.
  472.           - Andy Stewart for his programming help, and also for creating the
  473.             main play screen.
  474.           - Marcus and Ronda Eikenberry for their help in testing and finding
  475.             a few stubborn bugs.
  476.           - Gayle Davis and all the people that have contributed to the 
  477.             SWAG archives.  I have used various snippets from those
  478.             archives, as well as them giving me good ideas on how to
  479.             proceed next.  Thank you.
  480.  
  481. There are probably more people that I have forgotten, but these have been
  482. the most instrumental in the writing of this program.
  483.  
  484.